docs: add lit docs by fredericbahr · Pull Request #327 · TanStack/store

fredericbahr · 2026-05-13T16:39:37Z

The PR adds the following:

lists Lit as a framework in the overview section
adds lit specific installs in installation
add framework suffix for quick starts (fixes Docs: There are duplicate "Quick Start" menu items in the sidebar #270)
generate references for lit

Summary by CodeRabbit

New Features
- Added support for the Lit framework, bringing the library's compatibility to seven supported frameworks.
- New installation instructions and compatibility information for Lit 3 are now available.
Documentation
- Framework guides updated to reflect Lit support across all relevant sections.
- Quick Start resources now include framework-specific labels for streamlined access.

socket-security · 2026-05-13T16:47:15Z

No dependency changes detected. Learn more about Socket for GitHub.

👍 No dependency changes detected in pull request

fredericbahr · 2026-05-25T05:21:52Z

@KevinVandy or @crutchcorn could you perhaps have a look and approve this MR If you find Some spare time?

Kind regards.

nx-cloud · 2026-06-18T15:24:10Z

View your CI Pipeline Execution ↗ for commit 0bcf28e

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	1m 2s	View ↗
`nx run-many --target=build --exclude=examples/**`	✅ Succeeded	12s	View ↗

☁️ Nx Cloud last updated this comment at 2026-06-18 15:29:17 UTC

pkg-pr-new · 2026-06-18T15:24:31Z

@tanstack/angular-store

npm i https://pkg.pr.new/@tanstack/angular-store@327

@tanstack/lit-store

npm i https://pkg.pr.new/@tanstack/lit-store@327

@tanstack/preact-store

npm i https://pkg.pr.new/@tanstack/preact-store@327

@tanstack/react-store

npm i https://pkg.pr.new/@tanstack/react-store@327

@tanstack/solid-store

npm i https://pkg.pr.new/@tanstack/solid-store@327

@tanstack/store

npm i https://pkg.pr.new/@tanstack/store@327

@tanstack/svelte-store

npm i https://pkg.pr.new/@tanstack/svelte-store@327

@tanstack/vue-store

npm i https://pkg.pr.new/@tanstack/vue-store@327

commit: bcb87b3

coderabbitai · 2026-06-18T15:25:27Z

📝 Walkthrough

Walkthrough

Lit is added as a supported framework across TanStack Store's documentation. The README and overview text are updated to include Lit, a new installation section for @tanstack/lit-store is added with a Lit 3 compatibility note, all Quick Start nav labels in docs/config.json are renamed to be framework-specific, and a @tanstack/lit-store workspace override is added to package.json.

Changes

Lit Framework Documentation and Config

Layer / File(s)	Summary
Lit support in prose documentation `README.md`, `docs/overview.md`, `docs/installation.md`	README framework list and overview text are updated to include Lit; a new installation subsection adds the `npm install` @tanstack/lit-store`` command and a Lit 3 compatibility note.
Nav config labels and workspace override `docs/config.json`, `package.json`	All seven Quick Start nav entries in `docs/config.json` are renamed from the generic `"Quick Start"` to `"Quick Start - <Framework>"` (React, Vue, Solid, Angular, Svelte, Preact, Lit); `package.json` adds a `workspace:*` override for `@tanstack/lit-store`.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hop hop, a new flame burns bright,
Lit joins the store with radiant light!
Quick Start labels now bear their name,
Each framework shines—no two the same.
The warren grows, the docs are clear,
Another adapter? Bring it here! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is incomplete. While it lists the specific changes made, it does not follow the required template structure with sections for 'Changes', 'Checklist', and 'Release Impact'.	Restructure the description to match the repository template: add a '🎯 Changes' section with the current content, include the '✅ Checklist' section with required checkboxes, and specify '🚀 Release Impact' (e.g., if a changeset is needed for this docs-only change).

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: add lit docs' accurately summarizes the main change—adding documentation for the Lit framework to the repository.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/overview.md`:
- Line 8: In the overview.md file, locate the phrase "framework agnostic" in the
line describing TanStack Store's usage. Since this is a compound adjective
modifying "TanStack libraries", it needs to be hyphenated. Replace "framework
agnostic" with "framework-agnostic" to follow proper punctuation conventions for
compound adjectives.
- Line 6: In the overview.md file, hyphenate the compound adjectives to follow
standard English grammar rules. Change "framework agnostic" to
"framework-agnostic" in the description of TanStack Store, and change "framework
specific" to "framework-specific" where it refers to the adapters. Both
instances appear in the introductory section and should be updated to properly
hyphenate these compound modifiers that precede their nouns.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e229a8a1-34e4-4612-a03a-b632411407bc

📥 Commits

Reviewing files that changed from the base of the PR and between db21a76 and bcb87b3.

📒 Files selected for processing (5)

README.md
docs/config.json
docs/installation.md
docs/overview.md
package.json

coderabbitai · 2026-06-18T15:28:25Z

 ---

-TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, and Svelte.
+TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.


⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix hyphenation in compound adjectives.

Lines 6 and 8 use unhyphenated compound adjectives that should be hyphenated per standard English grammar rules. Specifically: "framework agnostic" → "framework-agnostic" and "framework specific" → "framework-specific".

✏️ Proposed fix

-TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit. +TanStack Store is a framework-agnostic data store that ships with framework-specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.

TanStack Store is a framework-agnostic data store that ships with framework-specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.

🧰 Tools

🪛 LanguageTool

[grammar] ~6-~6: Use a hyphen to join words.
Context: ...rview --- TanStack Store is a framework agnostic data store that ships with fram...

(QB_NEW_EN_HYPHEN)

[grammar] ~6-~6: Use a hyphen to join words.
Context: ...tic data store that ships with framework specific adapters for major frameworks l...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/overview.md` at line 6, In the overview.md file, hyphenate the compound adjectives to follow standard English grammar rules. Change "framework agnostic" to "framework-agnostic" in the description of TanStack Store, and change "framework specific" to "framework-specific" where it refers to the adapters. Both instances appear in the introductory section and should be updated to properly hyphenate these compound modifiers that precede their nouns.

Source: Linters/SAST tools

coderabbitai · 2026-06-18T15:28:25Z

+TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.

-TanStack Store is primarily used for state management internally for most framework agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.
+TanStack Store is primarily used for state management internally for most framework agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.


⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix hyphenation in compound adjective on line 8.

"framework agnostic" should be hyphenated as "framework-agnostic".

✏️ Proposed fix

-TanStack Store is primarily used for state management internally for most framework agnostic TanStack libraries. It can also be used as a standalone library for any framework or application. +TanStack Store is primarily used for state management internally for most framework-agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

TanStack Store is primarily used for state management internally for most framework agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.

TanStack Store is primarily used for state management internally for most framework-agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.

🧰 Tools

🪛 LanguageTool

[grammar] ~8-~8: Use a hyphen to join words.
Context: ...management internally for most framework agnostic TanStack libraries. It can also...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/overview.md` at line 8, In the overview.md file, locate the phrase "framework agnostic" in the line describing TanStack Store's usage. Since this is a compound adjective modifying "TanStack libraries", it needs to be hyphenated. Replace "framework agnostic" with "framework-agnostic" to follow proper punctuation conventions for compound adjectives.

Source: Linters/SAST tools

docs: add lit docs

463ffd3

fredericbahr force-pushed the docs-add-lit-adapter branch from a4a83f2 to 463ffd3 Compare May 13, 2026 16:46

Merge branch 'main' into docs-add-lit-adapter

0bcf28e

ci: apply automated fixes and generate docs

bcb87b3

coderabbitai Bot reviewed Jun 18, 2026

View reviewed changes

KevinVandy merged commit 78e3f86 into TanStack:main Jun 18, 2026
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add lit docs#327

docs: add lit docs#327
KevinVandy merged 3 commits into
TanStack:mainfrom
fredericbahr:docs-add-lit-adapter

fredericbahr commented May 13, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

socket-security Bot commented May 13, 2026 •

edited

Loading

Uh oh!

fredericbahr commented May 25, 2026

Uh oh!

nx-cloud Bot commented Jun 18, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Jun 18, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jun 18, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jun 18, 2026

Uh oh!

coderabbitai Bot Jun 18, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	TanStack Store is a framework agnostic data store that ships with framework specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.
	TanStack Store is a framework-agnostic data store that ships with framework-specific adapters for major frameworks like React, Solid, Vue, Angular, Svelte and Lit.

	TanStack Store is primarily used for state management internally for most framework agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.
	TanStack Store is primarily used for state management internally for most framework-agnostic TanStack libraries. It can also be used as a standalone library for any framework or application.

Uh oh!

Conversation

fredericbahr commented May 13, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

socket-security Bot commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fredericbahr commented May 25, 2026

Uh oh!

nx-cloud Bot commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jun 18, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jun 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fredericbahr commented May 13, 2026 •

edited by coderabbitai Bot

Loading

socket-security Bot commented May 13, 2026 •

edited

Loading

nx-cloud Bot commented Jun 18, 2026 •

edited

Loading

pkg-pr-new Bot commented Jun 18, 2026 •

edited

Loading

coderabbitai Bot commented Jun 18, 2026 •

edited

Loading